4.4.2.1 新增角色
可通过此接口在用户目录新增角色。
基本信息
请求地址：
https://SDPC-IP:4433/api/v3/role/create请求方式：
POST
请求头（Header）
- 请求体（Body）
| 参数 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| directoryDomain | 用户目录唯一标识 | 是 | string | 用户目录唯一标识，在控制台点击用户目录设置即可查看。 本地用户目录的唯一标识为 local。外部用户目录示例： custom01339（唯一标识无需携带@） |
| name | 角色名 | 是 | string | 角色名，同一个用户目录的角色名不允许重复。 示例： role1 30001 |
| externalId | 外部id | 否 | string | 不传时将自动生成。 示例：81dc9bdb52d04dc2 |
| description | 描述信息 | 否 | string |
- 请求示例
curl --location --request POST 'https://SDPC-IP:4433/api/v3/role/create?lang=zh-CN' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--data-raw '{
"directoryDomain": "local",
"name": "role1",
"description": "role created by openAPI",
"externalId": "81dc9bdb52d04dc2"
}'
- 返回数据
| 参数 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| code | 响应码 | string | OK 表示成功，其他表示出错。具体含义请参考错误码定义 |
| data | 响应数据 | object | |
| ├─ id | 新增角色的id | string | |
| msg | 描述信息 | string | |
| traceId | 调用链id | string |
- 响应示例
{
"code": "OK",
"data": {
"id": "1cbe7810-b8da-11ee-b4f8-43206df67e19"
},
"msg": "请求成功",
"traceId": "004566ab3f7a8a30"
}
错误码